home *** CD-ROM | disk | FTP | other *** search
/ Nebula 1 / Nebula One.iso / Internet / WWW / Perl_WWW_Utilities / total / formmail / README < prev   
Encoding:
Text File  |  1996-02-05  |  16.5 KB  |  444 lines
  1. ##############################################################################
  2. # FormMail            Version 1.5                     #
  3. # Copyright 1996 Matt Wright    mattw@misha.net                     #
  4. # Created on 6/9/95             Last Modified: 2/5/96                 #
  5. # Scripts Found at:        http://www.worldwidemart.com/scripts/         #
  6. ##############################################################################
  7. # If you run into any problems while trying to configure this scripts, help  #
  8. # is available.  The steps you should take to get the fastest results, are:  #
  9. #       1) Read this file thoroughly                         #
  10. #       2) Consult the Matt's Script Archive Frequently Asked Questions:     #
  11. #               http://www.worldwidemart.com/scripts/faq/             #
  12. #       3) If you are still having difficulty installing this script, send   #
  13. #          e-mail to: scripts-help@tahoenet.com                     #
  14. #          Include any error messages you are receiving and as much detail   #
  15. #          as you can so we can spot your problem.  Also include the variable#
  16. #          configuration block that is located at the top of the script.     #
  17. #                                         #
  18. # Hopefully we will be able to help you solve your problems.  Thank you.     #
  19. ##############################################################################
  20. # COPYRIGHT NOTICE                                 #
  21. # Copyright 1996 Matthew M. Wright  All Rights Reserved.             #
  22. #                                         #
  23. # FormMail may be used and modified free of charge by anyone so long as this #
  24. # copyright notice and the comments above remain intact.  By using this      #
  25. # code you agree to indemnify Matthew M. Wright from any liability that      # 
  26. # might arise from it's use.                             #
  27. #                                                                            #
  28. # Selling the code for this program without prior written consent is         #
  29. # expressly forbidden.  In other words, please ask first before you try and  #
  30. # make money off of my program.                                              #
  31. ##############################################################################
  32.  
  33.  
  34. This script can be used as a universal WWW form --> E-mail gateway.  There are 
  35. just a few restrictions on the HTML Forms and what they have to have in 
  36. them.  The script works for both the POST and GET form methods.
  37.  
  38. The script, FormMail.pl, needs to be placed in your server's cgi-bin and the 
  39. anonymous WWW user must have the ability to read/execute the script.  If 
  40. you do not have access to your server's cgi-bin, yet you can execute cgi 
  41. scripts, you may want to try adding a .cgi extension to the FormMail.pl, 
  42. so you could move it to FormMail.cgi.
  43.  
  44. Setting Up the FormMail Script:
  45. ===============================
  46.  
  47. The FormMail.pl script does not have to be extensively configured to get 
  48. it to work.  There are only two variables in the perl file which you will 
  49. need to define along with changing the top line of your script to match 
  50. the location of you Perl interpreter.
  51.  
  52. Necessary Variables:
  53. --------------------
  54.  
  55.   $mailprog = "/usr/lib/sendmail";
  56.     This variable must define the location to your server's sendmail 
  57.     program.  If this is incorrect, form results will not be mailed to you.
  58.  
  59.   @referers = ('www.worldwidemart.com','worldwidemart.com','206.31.72.203');
  60.     This array allows you to define the domains that you will allow 
  61.     forms to reside on and use your FormMail script.  If a user tries to 
  62.     put a form on another server, that is not www.worldwidemart.com, they 
  63.     will receive an error message when someone tries to fill out their form.
  64.  
  65. Your formmail program is now configured.
  66.  
  67. -----------------------------------------------------------------------------
  68.  
  69. Form Configuration:
  70. ===================
  71.  
  72. The action of your form needs to point towards this script (obviously), and 
  73. the method must be POST or GET in capital letters.  Version 1.5 of FormMail 
  74. offers many new ways to code your form to tailor the resulting HTML page 
  75. and the way the script performs.  Below is a list of form fields you can 
  76. use and how to implement them.
  77.  
  78. Necessary Form Fields:
  79. ======================
  80.  
  81. There is only one form field that you must have in your form, for 
  82. FormMail to work correctly.  This is the recipient field.
  83.  
  84. Field: recipient
  85.  
  86. Description: This form field allows you to specify to whom you wish for your 
  87. form results to be mailed.  Most likely you will want to configure this 
  88. option as a hidden form field with a value equal to that of your e-mail 
  89. address.
  90.  
  91. Syntax:
  92.  
  93. <input type=hidden name="recipient" value="email@your.host.xxx">
  94.  
  95. -----------------------------------------------------------------------------
  96.  
  97. Optional Form Fields:
  98. =====================
  99.  
  100. Field: subject
  101.  
  102. Description: The subject field will allow you to specify the subject that 
  103. you wish to appear in the e-mail that is sent to you after this form has 
  104. been filled out.  If you do not have this option turned on, then the 
  105. script will default to a message subject: WWW Form Submission
  106.  
  107. Syntax:
  108.  
  109. If you wish to choose what the subject is:
  110. <input type=hidden name="subject" value="Your Subject">
  111.  
  112. To allow the user to choose a subject:
  113. <input type=text name="subject">
  114.  
  115. -----------------------------------------------------------------------------
  116.  
  117. Field: email
  118.  
  119. Description: This form field will allow the user to specify their return 
  120. e-mail address.  If you want to be able to return e-mail to your user, I 
  121. strongly suggest that you include this form field and allow them to fill 
  122. it in.  This will be put into the From: field of the message you receive.
  123.  
  124. Syntax:
  125.  
  126. <input type=text name="email">
  127.  
  128. -----------------------------------------------------------------------------
  129.  
  130. Field: realname
  131.  
  132. Description:  The realname form field will allow the user to input their 
  133. real name.  This field is useful for identification purposes and will 
  134. also be put into the From: line of your message header.
  135.  
  136. Syntax: 
  137.  
  138. <input type=text name="realname">
  139.  
  140. -----------------------------------------------------------------------------
  141.  
  142. Field: redirect
  143.  
  144. Description:  If you wish to redirect the user to a different URL, rather 
  145. than having them see the default response to the fill-out form, you can 
  146. use this hidden variable to send them to a pre-made HTML page.
  147.  
  148. Syntax:
  149.  
  150. To choose the URL they will end up at:
  151. <input type=hidden name="redirect" value="http://your.address/to/file.html">
  152.  
  153. To allow them to specify a URL they wish to travel to once the form is 
  154. filled out:
  155. <input type=text name="redirect">
  156.  
  157. -----------------------------------------------------------------------------
  158.  
  159. Field: required
  160.  
  161. Version Added: 1.3
  162.  
  163. Description: You can now require for certain fields in your form to be 
  164. filled in before the user can successfully submit the form.  Simply place 
  165. all field names that you want to be mandatory into this field.  If the 
  166. required fields are not filled in, the user will be notified of what they 
  167. need to fill in, and a link back to the form they just submitted will be 
  168. provided.
  169.  
  170. Syntax:
  171.  
  172. If you want to require that they fill in the email and phone fields in 
  173. your form, so that you can reach them once you have received the mail, 
  174. use a syntax like:
  175. <input type=hidden name="required" value="email,phone">
  176.  
  177. -----------------------------------------------------------------------------
  178.  
  179. Field: env_report
  180.  
  181. Version Added: 1.3
  182.  
  183. Description: Allows you to have Environment variables included in the 
  184. e-mail message you receive after a user has filled out your form.  Useful 
  185. if you wish to know what browser they were using, what domain they were 
  186. coming from or any other attributes associated with environment 
  187. variables.  The following is a short list of valid environment variables 
  188. that might be useful:
  189.  
  190. REMOTE_HOST    - Sends the hostname making a request.
  191. REMOTE_ADDR    - Sends the IP address of the remote host making the request.
  192. REMOTE_USER    - If server supports authentication and script is 
  193.           protected, this is the username they have authenticated as.
  194.           *This is not usually set.*
  195. REMOTE_IDENT    - If HTTP server supports RFC 931 identification, then 
  196.           this variable will be set to the remote user name 
  197.           retrieved from the server. *This is not usually set.*
  198. HTTP_USER_AGENT    - The browser the client is using to send the request.  
  199.           General format: software/version library/version
  200.  
  201. There are others, but these are a few of the most useful.
  202.  
  203. Syntax:
  204.  
  205. If you wanted to find the remote host and browser sending the request, 
  206. you would put the following into your form:
  207. <input type=hidden name="env_report" value="REMOTE_HOST,HTTP_USER_AGENT">
  208.  
  209. -----------------------------------------------------------------------------
  210.  
  211. Field: sort
  212.  
  213. Version Added: 1.4
  214.  
  215. Description: This field allows you to choose the order in which you wish 
  216. for your variables to appear in the e-mail that FormMail generates.  You 
  217. can choose to have the field sorted alphabetically or specify a set order 
  218. in which you want the fields to appear in your mail message.  By leaving 
  219. this field out, the order will simply default to the order in which the 
  220. browsers sends the information to the script (which isn't always the 
  221. exact same order they appeared in the form.)  When sorting by a set order 
  222. of fields, you should include the phrase "order:" as the first part of 
  223. your value for the sort field, and then follow that with the field names 
  224. you want to be listed in the e-mail message, separated by commas.
  225.  
  226. Syntax:
  227.  
  228. To sort alphabetically:
  229. <input type=hidden name="sort" value="alphabetic">
  230.  
  231. To sort by a set field order:
  232. <input type=hidden name="sort" value="order:name1,name2,etc...">
  233.  
  234. -----------------------------------------------------------------------------
  235.  
  236. Field: print_config
  237.  
  238. Version Added: 1.5
  239.  
  240. Description: print_config allows you to specify which of the config 
  241. variables you would like to have printed in your e-mail message.  By 
  242. deafult, no config fields are printed to your e-mail.  This is because 
  243. the important form fields, like email, subject, etc... are included in 
  244. the header of the message.  However some users have asked for this option 
  245. so they can have these fields printed in the body of the message.  The 
  246. config fields that you wish to have printed shoul dbe in the value 
  247. attribute of your input tag separated by commas.
  248.  
  249. Syntax:
  250.  
  251. If you want to print the email and subject fields in the body of your 
  252. message, you would place the following form tag:
  253. <input type=hidden name="print_config" value="email,subject">
  254.  
  255. ----------------------------------------------------------------------------
  256.  
  257. Field: title
  258.  
  259. Version Added: 1.3
  260.  
  261. Description: This form field allows you to specify the title and header 
  262. that will appear on the resulting page if you do not specify a redirect URL.
  263.  
  264. Syntax:
  265.  
  266. If you wanted a title of 'Feedback Form Results':
  267. <input type=hidden name="title" value="Feedback Form Results">
  268.  
  269. -----------------------------------------------------------------------------
  270.  
  271. Field: return_link_url
  272.  
  273. Version Added: 1.3
  274.  
  275. Description:  This field allows you to specify a URL that will appear, as 
  276. return_link_title, on the following report page.  This field will not 
  277. be used if you have the redirect field set, but it is useful if you allow 
  278. the user to receive the report on the following page, but want to offer 
  279. them a way to get back to your main page.
  280.  
  281. Syntax:
  282.  
  283. <input type=hidden name="return_link_url" 
  284.                      value="http://your.host.xxx/main.html">
  285.  
  286. -----------------------------------------------------------------------------
  287.  
  288. Field: return_link_title
  289.  
  290. Version Added: 1.3
  291.  
  292. Description: This is the title that will be used to link the user back to 
  293. the page you specify with return_link_url.  The two fields will be shown 
  294. on the resulting form page as:
  295.  
  296. <ul>
  297. <li><a href="return_link_url">return_link_title</a>
  298. </ul>
  299.  
  300. Syntax:
  301.  
  302. <input type=hidden name="return_link_title" value="Back to Main Page">
  303.  
  304. -----------------------------------------------------------------------------
  305.  
  306. Field: background
  307.  
  308. Version Added: 1.3
  309.  
  310. Description: This form field allow you to specify a background image 
  311. that will appear if you do not have the redirect field set.  This image 
  312. will appear as the background to the form results page.
  313.  
  314. Syntax:
  315.  
  316. <input type=hidden name="background" value="http://your.host.xxx/image.gif">
  317.  
  318. -----------------------------------------------------------------------------
  319.  
  320. Field: bgcolor
  321.  
  322. Version Added: 1.3
  323.  
  324. Description:  This form field allow you to specify a bgcolor for the 
  325. form results page in much the way you specify a background image.  This 
  326. field should not be set if the redirect field is.
  327.  
  328. Syntax:
  329.  
  330. For a background color of White:
  331. <input type=hidden name="bgcolor" value="#FFFFFF">
  332.  
  333. -----------------------------------------------------------------------------
  334.  
  335. Field: text_color
  336.  
  337. Version Added: 1.3
  338.  
  339. Description: This field works in the same way as bgcolor, except that it 
  340. will change the color of your text.
  341.  
  342. Syntax:
  343.  
  344. For a text color of Black:
  345. <input type=hidden name="text_color" value="#000000">
  346.  
  347. -----------------------------------------------------------------------------
  348.  
  349. Field: link_color
  350.  
  351. Version Added: 1.3
  352.  
  353. Description: Changes the color of links on the resulting page.  Works in 
  354. the same way as text_color.  Should not be defined if redirect is.
  355.  
  356. Syntax:
  357.  
  358. For a link color of Red:
  359. <input type=hidden name="link_color" value="#FF0000">
  360.  
  361. -----------------------------------------------------------------------------
  362.  
  363. Field: vlink_color
  364.  
  365. Version Added: 1.3
  366.  
  367. Description: Changes the color of visited links on the resulting page.  
  368. Works exactly the same as link_color.  Should not be set if redirect is.
  369.  
  370. Syntax:
  371.  
  372. For a visited link color of Blue:
  373. <input type=hidden name="vlink_color" value="#0000FF">
  374.  
  375. -----------------------------------------------------------------------------
  376.  
  377. Field: alink_color
  378.  
  379. Version Added: 1.4
  380.  
  381. Description: Changes the color of active links on the resulting page. 
  382. Works exactly the same as link_color.  Should not be set if redirect is.
  383.  
  384. Syntax:
  385.  
  386. For a visited link color of Blue:
  387. <input type=hidden name="alink_color" value="#0000FF">
  388.  
  389. -----------------------------------------------------------------------------
  390.  
  391. Any other form fields that appear in your script will be mailed back to 
  392. you and displayed on the resulting page if you do not have the redirect 
  393. field set.  There is no limit as to how many other form fields you can 
  394. use with this form, except the limits imposed by browsers and your server.
  395.  
  396. -----------------------------------------------------------------------------
  397.  
  398. Some of the possible uses of this script are:
  399.  
  400. 1) You want to have a form that will be mailed to you, but aren't sure how to 
  401.    write the scripting for it.
  402. 2) You are the webmaster of your site and want to allow users to use forms, 
  403.    but not to have their own cgi-bin directories, which can cause 
  404.    security risks to your system.  You can set this script up and then 
  405.    allow all users to run off of it.
  406. 3) Want to have one script to parse all of your html forms and mail them 
  407.    to you.
  408.  
  409. -----------------------------------------------------------------------------
  410.  
  411. History:
  412. Version 1.0     6/11 -  This script was created.
  413. Version 1.1     8/3  -  A major hole in the script which allowed users to run 
  414.                         commands under your server's uid was disabled, thanks 
  415.                         to Paul Phillips, who noticed the error.
  416.                      -  The ability to redirect the user to a specified HTML 
  417.                         file after they filled out a form was added.
  418. Version 1.2     9/23 -  If the form field is one of the required or optional 
  419.                         'special' fields, such as redirect, recipient, 
  420.                         subject, email, realname, etc... the script will not 
  421.                         print these fields to either your mail message or to 
  422.                         the user's screen when they are returned to a generic 
  423.                         form response.  It helps you so that things do not 
  424.                         get duplicated.
  425. Version 1.3    1/21 -  Much needed update finally completed
  426.              -  Added form fields: env_report, bgcolor, 
  427.                 background, link_color, vlink_color, title,
  428.                 text_color, return_link_title, return_link_url 
  429.             and required.
  430.              -  Security hole, which allowed any user on any 
  431.             system to bum off of your formmail script, has been 
  432.             plugged up with the @referers variable.
  433.              -  Report style in return html and e-mail touched 
  434.             up a bit.
  435. Version 1.4    1/23 -  Added options: sort, alink_color
  436.              -  Fixed a few bugs from Version 1.3, namely the fact 
  437.             that the link_colors weren't working well.
  438.              -  FormMail now supports both the GET and POST methods.
  439. Version 1.5    2/5  -  Sorting of Fields in E-Mail Response Fixed.
  440.              -  print_config option added.
  441.  
  442. -----------------------------------------------------------------------------
  443. Matt Wright - (mattw@misha.net) - http://www.worldwidemart.com/scripts/
  444.